factfind

Retrieve the Factfind for a given user

GraphQL Schema

extend type query {
  """Retrieve the Factfind for a given user"""
  factfind(userId: ID!): Factfind!
}

Arguments

Name	Type	Description
userId	ID!	Unique ID of the user

Response Shape

This query returns Factfind!

Name	Type	Description
id	ID!	Unique ID of the object
planningFor	PlanScope	Who the plan is for
maritalStatus	MaritalStatus	User's marital status
hasChildren	Boolean	Does the user have children?
numberOfChildren	Int	Number of children
ageOfChildren	[Int]	Age of children
otherDependants	Boolean	Any other dependants?
relationshipToDependants	DependantRelationship	Relationship to dependants
numberOfOtherDependants	Int	Number of other dependants
relationshipToOtherDependants	[DependantRelationship]	Relationship to dependants
ownsHome	Boolean	Whether the user owns their own home
hasMortgage	Boolean	Whether the user has a mortgage on their home
userSpecificFactfind	PersonFactfind	Additional factfind information relating to the user
partnerSpecificFactfind	PersonFactfind	Additional factfind information relating to the user's partner
monthlyRent	Float	Monthly rent
monthlyUtilities	Float	Monthly utilities cost
monthlyOutgoingEssentials	Float	Essential monthly spending - should be >= than monthlyRent + monthlyUtilities
extraMonthlyOutgoingEssentials	Float	Extra Essential monthly spending should be (essentialOutgoings - monthlyRent - monthlyBills)
monthlyOutgoingNonEssentials	Float	Non essential monthly spending
vulnerable	Boolean	Is the user vulnerable